fix: change onBrokenLinks to 'warn' to prevent doc build failures#2042
Closed
Yilialinn wants to merge 1 commit into
Closed
fix: change onBrokenLinks to 'warn' to prevent doc build failures#2042Yilialinn wants to merge 1 commit into
Yilialinn wants to merge 1 commit into
Conversation
The doc workspace build was failing because navbar links pointing to website workspace paths (/, /blog, /learning-center, etc.) were being treated as errors when onBrokenLinks was set to 'log'. Changing to 'warn' allows the build to complete while still alerting developers to actual broken documentation links. This fixes the doc build failures seen in CI runs starting from May 13, 2026.
shreemaan-abhishek
approved these changes
May 13, 2026
Contributor
Author
|
Closing this PR. After reconsideration, we should fix the broken links instead of suppressing the errors. Will submit a proper fix shortly. |
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates the doc workspace’s Docusaurus configuration to avoid build failures caused by intentionally cross-workspace navbar links being treated as broken.
Changes:
- Changed
onBrokenLinkshandling from logging/failing behavior to warnings in the doc workspace config.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| }, | ||
| }, | ||
| onBrokenLinks: 'log', | ||
| onBrokenLinks: 'warn', |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fix doc workspace build failures caused by navbar links to website workspace paths being treated as errors.
Problem
The doc build started failing on May 13, 2026 with error:
Root cause: The doc workspace's
docusaurus.config.jshadonBrokenLinks: 'log', which caused Docusaurus to fail the build when encountering navbar links to paths that exist in the website workspace but not in the doc workspace (like/,/blog,/learning-center,/downloads,/help,/team,/showcase,/plugins).Solution
Changed
onBrokenLinks: 'log'toonBrokenLinks: 'warn'indoc/docusaurus.config.js.This allows the build to complete successfully while still alerting developers about actual broken documentation links. The navbar links are intentionally cross-workspace references and should not fail the build.
Testing
yarn workspace doc buildRelated